/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

#import "OFXAssetClassPortion.h"
#import "OFXSecurity.h"

@interface OFXStock : OFXSecurity {
  NSString* stockType;
  NSNumber* yield;
  NSDate* yieldValidAsOf;
  NSString* assetClass;
  NSString* financialInstitutionAssetClass;
}

/**
 * @property stockType
 * @brief Stock type: COMMON, PREFERRED, CONVERTIBLE, OTHER
 */
@property(retain) NSString* stockType;

/**
 * @property yield
 * @brief Current yield reported as the dividend expressed as a portion of the 
 * current stock price
 */
@property(retain) NSNumber* yield;

/**
 * @property yieldValidAsOf
 * @brief As-of date for yield value
 */
@property(retain) NSDate* yieldValidAsOf;

/**
 * @property assetClass
 * @brief Asset Class
 *
 * One of: 
 * - DOMESTICBOND
 * - INTLBOND
 * - LARGESTOCK 
 * - SMALLSTOCK
 * - INTLSTOCK
 * - MONEYMRKT
 * - OTHER
 */
@property(retain) NSString* assetClass;

/**
 * @property financialInstitutionAssetClass
 * @brief Financial institution assigned asset class.
 */
@property(retain) NSString* financialInstitutionAssetClass;

@end
